package com.sword.demo.basic.config;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * Swagger配置类
 * @author sword
 * @date 2020-07-07 11:13:57
 */
@Configuration
public class SwaggerConfig {

    /**
     * 返回swaggerAPI文档
     * @return springfox.documentation.spring.web.plugins.Docket
     * @author sword
     * @date 2020-07-07 11:13:57
     */
    @Bean
    public OpenAPI swaggerApi() {
        return new OpenAPI()
                .info(apiInfo());
    }

    /**
     * 返回一个API基本信息
     * @return springfox.documentation.service.ApiInfo
     * @author sword
     * @date 2020-07-07 11:13:57
     */
    private Info apiInfo() {
        return new Info()
                // 标题
                .title("API文档标题")
                // 描述
                .description("API文档描述")
                // 设置联系人名称、网址、电子邮件
                .contact(new Contact().name("sword").url("http://localhost:8080/demo").email("******@163.com"))
                // 文档的版本
                .version("1.0");
    }
}